CAMEL-13920: Allow using markup in option description - #3137

Thanks for the pull request, now it's a bit clearer for me to see what you're trying to fix.

Does prefixing table columns with a help to render those correctly? I seem to recall that if you wanted a table to contain Asciidoc content which in turn can contain HTML you needed to use syntax like:

|===
a| *markdown* or <strong>html</strong>
|===

Hmm that actually doesn't work, I've tried the example I provided and it renders the <strong>html</strong> verbatim.

Another option could be to take the JavaDoc content and convert it to Markdown in the Camel package Maven plugin. Perhaps using something like remark.

I was thinking about converting HTML to markdown too, but havent found a way get full javadoc in UpdateReadmeMojo, because the model in this mojo have already stripped html tags. As Claus mentioned in Jira, it is not safe to include HTML tags in json model description, but maybe we can add to model new attribute, which will contain description with tags? Or is there already a place, where it can be obtained, which I am missing?

Javadoc documentation is not as important as the website docs and tooling docs (eg spring boot metadata etc). So I am fine with formatting the source code so it render better on the website. I dont like having 2 set of description in the json file.

Perhaps we can go with this solution and then in a subsequent refinement try to modify the toolchain so that we get raw JavaDoc content including HTML in the Maven mojos so we can change format as needed: strip HTML for JSON catalog and convert to Markdown for Asciidoc files.

Agree. I will add few comments to mvel template regarding a prefix and then merge this after full local build. Current solution relies on \n, which is suitable for lists, but it will not detect inline markups - e.g. links, these are still stripped out from javadoc in current solution. I will keep the jira open, so we can eventualy find a complete solution later. Thanks for your inputs.